home *** CD-ROM | disk | FTP | other *** search
- /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corporation.
- * Portions created by the Initial Developer are Copyright (C) 1998-2002
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- * Akkana Peck <akkana@netscape.com>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either of the GNU General Public License Version 2 or later (the "GPL"),
- * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsISupports.idl"
-
- interface nsISupportsArray;
- interface nsIDOMNode;
-
- [scriptable, uuid(fdf23301-4a94-11d3-9ce4-9960496c41bc)]
-
- interface nsIEditorMailSupport : nsISupports
- {
- /** Paste the text in the OS clipboard at the cursor position,
- * as a quotation (whose representation is dependant on the editor type),
- * replacing the selected text (if any).
- * @param aSelectionType Text or html?
- */
- void pasteAsQuotation(in long aSelectionType);
-
- /** Insert a string as quoted text
- * (whose representation is dependant on the editor type),
- * replacing the selected text (if any).
- * @param aQuotedText The actual text to be quoted
- * @return The node which was inserted
- */
- nsIDOMNode insertAsQuotation(in AString aQuotedText);
-
- /**
- * Inserts a plaintext string at the current location,
- * with special processing for lines beginning with ">",
- * which will be treated as mail quotes and inserted
- * as plaintext quoted blocks.
- * If the selection is not collapsed, the selection is deleted
- * and the insertion takes place at the resulting collapsed selection.
- *
- * @param aString the string to be inserted
- */
- void insertTextWithQuotations(in DOMString aStringToInsert);
-
- /** Paste a string as quoted text,
- * whose representation is dependant on the editor type,
- * replacing the selected text (if any)
- * @param aCitation The "mid" URL of the source message
- * @param aSelectionType Text or html?
- */
- void pasteAsCitedQuotation(in AString aCitation,
- in long aSelectionType);
-
- /** Insert a string as quoted text
- * (whose representation is dependant on the editor type),
- * replacing the selected text (if any),
- * including, if possible, a "cite" attribute.
- * @param aQuotedText The actual text to be quoted
- * @param aCitation The "mid" URL of the source message
- * @param aInsertHTML Insert as html? (vs plaintext)
- * @return The node which was inserted
- */
- nsIDOMNode insertAsCitedQuotation(in AString aQuotedText,
- in AString aCitation,
- in boolean aInsertHTML);
-
- /**
- * Rewrap the selected part of the document, re-quoting if necessary.
- * @param aRespectNewlines Try to maintain newlines in the original?
- */
- void rewrap(in boolean aRespectNewlines);
-
- /**
- * Strip any citations in the selected part of the document.
- */
- void stripCites();
-
-
- /**
- * Get a list of IMG and OBJECT tags in the current document.
- */
- nsISupportsArray getEmbeddedObjects();
- };
-
-